IApi.ReadAxisSecondEncoder method

Reads the current position from an axis using the secondary encoder.

Namespace: IntervalZero.KINGSTAR.Base.Api

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

C#VB
KsReturn<int> ReadAxisSecondEncoder(
       int Index
)
Function ReadAxisSecondEncoder(
       Index As Integer
) As KsReturn(Of Integer)

Parameters

Index

Type: int

The index of an axis. Indexes are zero based. Aliases affect this parameter.

Return value

Type: KsReturn<int>

Returns a KsError code and an integer value.

Remarks

Used in the cyclic callback to check the internal position of an axis.

NOTE:  The internal position is available only if EnableSecondEncoder is enabled.

Usable EtherCAT states

ecatOP

Examples

C#
N/A

See also

IApi Interface

IntervalZero.KINGSTAR.Base.Api Namespace